Feature description

Review and update the API documentation for the radial gauge and linear gauge widgets.

Key objectives:

• Ensure all public APIs are fully documented.
• Ensure the inclusion of correct hyperlinks, default property values in documentation.
• Ensure the public APIs content were correct in the documentation.

Analysis and design

• Task ID - [FLUT-965285]
• Audit all public APIs in the gauges widget to ensure comprehensive documentation.
• Identify any undocumented APIs and draft descriptive content, including usage examples.
• Verify that all API entries contain appropriate hyperlinks for seamless developer reference.
• Confirm that default property values are clearly specified across all relevant entries.
• Detect and correct inaccuracies or misleading information in the existing documentation.
• Issue noted document link - Gauges UG documentation issues

Solution description

• Verified the full set of APIs by cross-checking with the API reference on pub.dev.
• Identified missing APIs and added comprehensive documentation for them.
• Reviewed and updated the documentation to include any missing hyperlinks for accurate cross-referencing.
• Assessed the API documentation content for accuracy and made necessary corrections.
• Validated default property values and updated them where discrepancies were found.

Output screenshots

Added images for missing API:
edgeStyle

onCreatePointerRenderer

Areas affected and ensured

Code snippets and content have been affected due to the modification.

API Changes

Missed API in this documentation changes

• edgeStyle - Added
• onCreatePointerRenderer - Added
• onAnimationCompleted - Added
• factorToValueCallback - Not needed, Mostly we don't use any factor values in slider labels.

Behavioral Changes

No behavioral changes due to this modification.

Test cases

No test cases for this PR.

Testbed sample location

No needed for this specific task.

Does it have any known issues?

No.

Does it have memory leak?

Not applicable

MR CheckList

• Does it follow the design guidelines? It is mandatory that, we should not move the changes without reading this. Yes, followed the guidelines
• Did UI automation passed without errors? If it is customer issue, make sure it is included in the IR automation. It is a documentation related work, so Not applicable
• Properly working in Xamarin.Forms previewer.
• Ensured in iOS, Android, UWP and macOS (if supported). Not applicable
• Have you added API comments if it is new API? Not applicable
• Does it need localization? If so, update resx file in GitHub. Not applicable
• Whether we have added new APIs? If so, whether it is as per the guidelines? Not applicable
• If changes are made in the Xamarin.Forms sample browser project file, whether it is included in the props file too? If not, your sample level changes will not reflect in the application published in the hockey app. Not applicable
• Have you ensured the changes in Android API 19 and iOS 9? Not applicable